org.eclipse.vtp.framework.core
Interface IReporter

All Known Subinterfaces:

IActionContext, IContext, IExecutionContext, ILogger, IProcessContext, ISessionContext

All Known Implementing Classes:

AbstractActionContext, AbstractContext, AbstractExecutionContext, AbstractLogger, AbstractProcessContext, AbstractReporter, AbstractSessionContext, ActionContextWrapper, Activator, Execution.Context, ExecutionContextWrapper, Process.Context, ProcessContextWrapper, Sequence.Context, Session.Context, SessionContextWrapper

public interface IReporter

An interface to report generic events to.

Author:

Lonnie Pryor

Field Summary

static int	SEVERITY_DEBUG The debug severity constant.
static int	SEVERITY_ERROR The error severity constant.
static int	SEVERITY_INFO The informational severity constant.
static int	SEVERITY_WARN The warning severity constant.

Method Summary

boolean	isSeverityEnabled(int severity) Returns true if the specified severity level is enabled.
void	report(int severity, java.lang.String message) Creates and publishes a reporting entry with the specified attributes.
void	report(int severity, java.lang.String[] categories, java.lang.String message) Creates and publishes a reporting entry with the specified attributes.
void	report(int severity, java.lang.String[] categories, java.lang.String message, java.util.Dictionary properties) Creates and publishes a reporting entry with the specified attributes.
void	report(int severity, java.lang.String message, java.util.Dictionary properties) Creates and publishes a reporting entry with the specified attributes.

Field Detail

SEVERITY_ERROR

static final int SEVERITY_ERROR

The error severity constant.

See Also:

Constant Field Values

SEVERITY_WARN

static final int SEVERITY_WARN

The warning severity constant.

See Also:

Constant Field Values

SEVERITY_INFO

static final int SEVERITY_INFO

The informational severity constant.

See Also:

Constant Field Values

SEVERITY_DEBUG

static final int SEVERITY_DEBUG

The debug severity constant.

See Also:

Constant Field Values

Method Detail

isSeverityEnabled

boolean isSeverityEnabled(int severity)

Returns true if the specified severity level is enabled.

Parameters:

severity - The severity to check.

Returns:

True if the specified severity level is enabled.

report

void report(int severity,
            java.lang.String message)

Creates and publishes a reporting entry with the specified attributes.

Parameters:

severity - The severity of the report.

message - The message associated with the report or null to not include a message.

report

void report(int severity,
            java.lang.String message,
            java.util.Dictionary properties)

Creates and publishes a reporting entry with the specified attributes.

Parameters:

severity - The severity of the report.

message - The message associated with the report or null to not include a message.

properties - The properties of the report or null if no properties are specified.

report

void report(int severity,
            java.lang.String[] categories,
            java.lang.String message)

Creates and publishes a reporting entry with the specified attributes.

Parameters:

severity - The severity of the report.

categories - The categories the report pertains to or null if no catagories are related.

message - The message associated with the report or null to not include a message.

report

void report(int severity,
            java.lang.String[] categories,
            java.lang.String message,
            java.util.Dictionary properties)

Creates and publishes a reporting entry with the specified attributes.

Parameters:

severity - The severity of the report.

categories - The categories the report pertains to or null if no catagories are related.

message - The message associated with the report or null to not include a message.

properties - The properties of the report or null if no properties are specified.